Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install_windows_src tutorial for Harmonic #374

Merged
merged 2 commits into from
Aug 29, 2023

Conversation

traversaro
Copy link
Contributor

🎉 New feature

Summary

I update the instruction for installation from source on Windows.

Improvements include:

  • Suggest to use miniforge to install conda instead of miniconda, as we always use conda-forge dependencies, this should reduce the possibility of people installing a bit of packages from conda-forge and a bit from defaults/anaconda, that is not supported (see Libraries are not found  gz-sim#2082)
  • Suggest to also install dartsim and ogre-next as dependencies, that now are available in conda-forge
  • Suggest to install libprotobuf (the C++ libraries) instead of protobuf (the Python library)
  • Mention in the documentation that install instructions are valid also for Windows 11

I do not know what to do for citadel, fortress and garden documentation, I can do similar changes there (perhaps excluding adding ogre-next and dartsim that I did not tested with older distributions)

Test it

Follow the documentation on Windows.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@github-actions github-actions bot added the 🎵 harmonic Gazebo Harmonic label Aug 27, 2023
@azeey azeey added the beta label Aug 28, 2023
Copy link
Contributor

@mabelzhang mabelzhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds reasonable.

I don't have a Windows setup ready to test this at the moment.
If someone who knows more about Windows wants to give this a look, that'd be good.

harmonic/install_windows_src.md Outdated Show resolved Hide resolved
Co-authored-by: Mabel Zhang <[email protected]>
Signed-off-by: Silvio Traversaro <[email protected]>
Copy link
Contributor

@mabelzhang mabelzhang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm gonna approve this so it can make it in time for the code freeze.
If somebody sees something wrong, documentation can be changed later.

@mabelzhang mabelzhang merged commit e6644fa into gazebosim:master Aug 29, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beta 🎵 harmonic Gazebo Harmonic
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants